/*
 * Copyright (C) 2021 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.copybara.onboard;

import com.google.common.collect.ImmutableSet;

/** A template object for use in Copybara's assisted onboarding. */
public interface ConfigTemplate {

  /** Locations for parameters */
  enum Location {
    NAMED,
    KEYWORD,
  }

  /** Type of parameter */
  enum FieldClass {
    STRING,
    INT,
    STARLARK
  }

  ImmutableSet<com.google.copybara.onboard.RequiredField> getRequiredFields();

  ImmutableSet<com.google.copybara.onboard.OptionalField> getOptionalFields();

  boolean validate(String configInProgress);

  String getTemplateString();

  String name();
}
